Your First GAN

Goal

In this notebook, you're going to create your first generative adversarial network (GAN) for this course! Specifically, you will build and train a GAN that can generate hand-written images of digits (0-9). You will be using PyTorch in this specialization, so if you're not familiar with this framework, you may find the PyTorch documentation useful. The hints will also often include links to relevant documentation.

Learning Objectives

  1. Build the generator and discriminator components of a GAN from scratch.
  2. Create generator and discriminator loss functions.
  3. Train your GAN and visualize the generated images.

Getting Started

You will begin by importing some useful packages and the dataset you will use to build and train your GAN. You are also provided with a visualizer function to help you investigate the images your GAN will create.

In [1]:
import torch
from torch import nn
from tqdm.auto import tqdm
from torchvision import transforms
from torchvision.datasets import MNIST # Training dataset
from torchvision.utils import make_grid
from torch.utils.data import DataLoader
import matplotlib.pyplot as plt
torch.manual_seed(0) # Set for testing purposes, please do not change!

def show_tensor_images(image_tensor, num_images=25, size=(1, 28, 28)):
    '''
    Function for visualizing images: Given a tensor of images, number of images, and
    size per image, plots and prints the images in a uniform grid.
    '''
    image_unflat = image_tensor.detach().cpu().view(-1, *size)
    image_grid = make_grid(image_unflat[:num_images], nrow=5)
    plt.imshow(image_grid.permute(1, 2, 0).squeeze())
    plt.show()

MNIST Dataset

The training images your discriminator will be using is from a dataset called MNIST. It contains 60,000 images of handwritten digits, from 0 to 9, like these:

MNIST Digits

You may notice that the images are quite pixelated -- this is because they are all only 28 x 28! The small size of its images makes MNIST ideal for simple training. Additionally, these images are also in black-and-white so only one dimension, or "color channel", is needed to represent them (more on this later in the course).

Tensor

You will represent the data using tensors. Tensors are a generalization of matrices: for example, a stack of three matrices with the amounts of red, green, and blue at different locations in a 64 x 64 pixel image is a tensor with the shape 3 x 64 x 64.

Tensors are easy to manipulate and supported by PyTorch, the machine learning library you will be using. Feel free to explore them more, but you can imagine these as multi-dimensional matrices or vectors!

Batches

While you could train your model after generating one image, it is extremely inefficient and leads to less stable training. In GANs, and in machine learning in general, you will process multiple images per training step. These are called batches.

This means that your generator will generate an entire batch of images and receive the discriminator's feedback on each before updating the model. The same goes for the discriminator, it will calculate its loss on the entire batch of generated images as well as on the reals before the model is updated.

Generator

The first step is to build the generator component.

You will start by creating a function to make a single layer/block for the generator's neural network. Each block should include a linear transformation to map to another shape, a batch normalization for stabilization, and finally a non-linear activation function (you use a ReLU here) so the output can be transformed in complex ways. You will learn more about activations and batch normalization later in the course.

In [2]:
# UNQ_C1 (UNIQUE CELL IDENTIFIER, DO NOT EDIT)
# GRADED FUNCTION: get_generator_block
def get_generator_block(input_dim, output_dim):
    '''
    Function for returning a block of the generator's neural network
    given input and output dimensions.
    Parameters:
        input_dim: the dimension of the input vector, a scalar
        output_dim: the dimension of the output vector, a scalar
    Returns:
        a generator neural network layer, with a linear transformation 
          followed by a batch normalization and then a relu activation
    '''
    return nn.Sequential(
        # Hint: Replace all of the "None" with the appropriate dimensions.
        # The documentation may be useful if you're less familiar with PyTorch:
        # https://pytorch.org/docs/stable/nn.html.
        #### START CODE HERE ####
        nn.Linear(input_dim, output_dim),
        nn.BatchNorm1d(output_dim),
        nn.ReLU(inplace=True),
        #### END CODE HERE ####
    )
In [3]:
# Verify the generator block function
def test_gen_block(in_features, out_features, num_test=1000):
    block = get_generator_block(in_features, out_features)

    # Check the three parts
    assert len(block) == 3
    assert type(block[0]) == nn.Linear
    assert type(block[1]) == nn.BatchNorm1d
    assert type(block[2]) == nn.ReLU
    
    # Check the output shape
    test_input = torch.randn(num_test, in_features)
    test_output = block(test_input)
    assert tuple(test_output.shape) == (num_test, out_features)
    assert test_output.std() > 0.55
    assert test_output.std() < 0.65

test_gen_block(25, 12)
test_gen_block(15, 28)
print("Success!")
Success!

Now you can build the generator class. It will take 3 values:

  • The noise vector dimension
  • The image dimension
  • The initial hidden dimension

Using these values, the generator will build a neural network with 5 layers/blocks. Beginning with the noise vector, the generator will apply non-linear transformations via the block function until the tensor is mapped to the size of the image to be outputted (the same size as the real images from MNIST). You will need to fill in the code for final layer since it is different than the others. The final layer does not need a normalization or activation function, but does need to be scaled with a sigmoid function.

Finally, you are given a forward pass function that takes in a noise vector and generates an image of the output dimension using your neural network.

Optional hints for Generator 1. The output size of the final linear transformation should be im_dim, but remember you need to scale the outputs between 0 and 1 using the sigmoid function. 2. [nn.Linear](https://pytorch.org/docs/master/generated/torch.nn.Linear.html) and [nn.Sigmoid](https://pytorch.org/docs/master/generated/torch.nn.Sigmoid.html) will be useful here.
In [4]:
# UNQ_C2 (UNIQUE CELL IDENTIFIER, DO NOT EDIT)
# GRADED FUNCTION: Generator
class Generator(nn.Module):
    '''
    Generator Class
    Values:
        z_dim: the dimension of the noise vector, a scalar
        im_dim: the dimension of the images, fitted for the dataset used, a scalar
          (MNIST images are 28 x 28 = 784 so that is your default)
        hidden_dim: the inner dimension, a scalar
    '''
    def __init__(self, z_dim=10, im_dim=784, hidden_dim=128):
        super(Generator, self).__init__()
        # Build the neural network
        self.gen = nn.Sequential(
            get_generator_block(z_dim, hidden_dim),
            get_generator_block(hidden_dim, hidden_dim * 2),
            get_generator_block(hidden_dim * 2, hidden_dim * 4),
            get_generator_block(hidden_dim * 4, hidden_dim * 8),
            # There is a dropdown with hints if you need them! 
            #### START CODE HERE ####
            nn.Linear(hidden_dim*8, im_dim),
            nn.Sigmoid()
            #### END CODE HERE ####
        )
    def forward(self, noise):
        '''
        Function for completing a forward pass of the generator: Given a noise tensor, 
        returns generated images.
        Parameters:
            noise: a noise tensor with dimensions (n_samples, z_dim)
        '''
        return self.gen(noise)
    
    # Needed for grading
    def get_gen(self):
        '''
        Returns:
            the sequential model
        '''
        return self.gen
In [5]:
# Verify the generator class
def test_generator(z_dim, im_dim, hidden_dim, num_test=10000):
    gen = Generator(z_dim, im_dim, hidden_dim).get_gen()
    
    # Check there are six modules in the sequential part
    assert len(gen) == 6
    test_input = torch.randn(num_test, z_dim)
    test_output = gen(test_input)

    # Check that the output shape is correct
    assert tuple(test_output.shape) == (num_test, im_dim)
    assert test_output.max() < 1, "Make sure to use a sigmoid"
    assert test_output.min() > 0, "Make sure to use a sigmoid"
    assert test_output.std() > 0.05, "Don't use batchnorm here"
    assert test_output.std() < 0.15, "Don't use batchnorm here"

test_generator(5, 10, 20)
test_generator(20, 8, 24)
print("Success!")
Success!

Noise

To be able to use your generator, you will need to be able to create noise vectors. The noise vector z has the important role of making sure the images generated from the same class don't all look the same -- think of it as a random seed. You will generate it randomly using PyTorch by sampling random numbers from the normal distribution. Since multiple images will be processed per pass, you will generate all the noise vectors at once.

Note that whenever you create a new tensor using torch.ones, torch.zeros, or torch.randn, you either need to create it on the target device, e.g. torch.ones(3, 3, device=device), or move it onto the target device using torch.ones(3, 3).to(device). You do not need to do this if you're creating a tensor by manipulating another tensor or by using a variation that defaults the device to the input, such as torch.ones_like. In general, use torch.ones_like and torch.zeros_like instead of torch.ones or torch.zeros where possible.

Optional hint for get_noise 1. You will probably find [torch.randn](https://pytorch.org/docs/master/generated/torch.randn.html) useful here.
In [8]:
# UNQ_C3 (UNIQUE CELL IDENTIFIER, DO NOT EDIT)
# GRADED FUNCTION: get_noise
def get_noise(n_samples, z_dim, device='cpu'):
    '''
    Function for creating noise vectors: Given the dimensions (n_samples, z_dim),
    creates a tensor of that shape filled with random numbers from the normal distribution.
    Parameters:
        n_samples: the number of samples to generate, a scalar
        z_dim: the dimension of the noise vector, a scalar
        device: the device type
    '''
    # NOTE: To use this on GPU with device='cuda', make sure to pass the device 
    # argument to the function you use to generate the noise.
    #### START CODE HERE ####
    return torch.randn(n_samples, z_dim).to(device)
    #### END CODE HERE ####
In [9]:
# Verify the noise vector function
def test_get_noise(n_samples, z_dim, device='cpu'):
    noise = get_noise(n_samples, z_dim, device)
    
    # Make sure a normal distribution was used
    assert tuple(noise.shape) == (n_samples, z_dim)
    assert torch.abs(noise.std() - torch.tensor(1.0)) < 0.01
    assert str(noise.device).startswith(device)

test_get_noise(1000, 100, 'cpu')
if torch.cuda.is_available():
    test_get_noise(1000, 32, 'cuda')
print("Success!")
Success!

Discriminator

The second component that you need to construct is the discriminator. As with the generator component, you will start by creating a function that builds a neural network block for the discriminator.

Note: You use leaky ReLUs to prevent the "dying ReLU" problem, which refers to the phenomenon where the parameters stop changing due to consistently negative values passed to a ReLU, which result in a zero gradient. You will learn more about this in the following lectures!

REctified Linear Unit (ReLU) Leaky ReLU
In [12]:
# UNQ_C4 (UNIQUE CELL IDENTIFIER, DO NOT EDIT)
# GRADED FUNCTION: get_discriminator_block
def get_discriminator_block(input_dim, output_dim):
    '''
    Discriminator Block
    Function for returning a neural network of the discriminator given input and output dimensions.
    Parameters:
        input_dim: the dimension of the input vector, a scalar
        output_dim: the dimension of the output vector, a scalar
    Returns:
        a discriminator neural network layer, with a linear transformation 
          followed by an nn.LeakyReLU activation with negative slope of 0.2 
          (https://pytorch.org/docs/master/generated/torch.nn.LeakyReLU.html)
    '''
    return nn.Sequential(
        #### START CODE HERE ####
        nn.Linear(input_dim, output_dim),
        nn.LeakyReLU(0.2)
        #### END CODE HERE ####
    )
In [13]:
# Verify the discriminator block function
def test_disc_block(in_features, out_features, num_test=10000):
    block = get_discriminator_block(in_features, out_features)

    # Check there are two parts
    assert len(block) == 2
    test_input = torch.randn(num_test, in_features)
    test_output = block(test_input)

    # Check that the shape is right
    assert tuple(test_output.shape) == (num_test, out_features)
    
    # Check that the LeakyReLU slope is about 0.2
    assert -test_output.min() / test_output.max() > 0.1
    assert -test_output.min() / test_output.max() < 0.3
    assert test_output.std() > 0.3
    assert test_output.std() < 0.5

test_disc_block(25, 12)
test_disc_block(15, 28)
print("Success!")
Success!

Now you can use these blocks to make a discriminator! The discriminator class holds 2 values:

  • The image dimension
  • The hidden dimension

The discriminator will build a neural network with 4 layers. It will start with the image tensor and transform it until it returns a single number (1-dimension tensor) output. This output classifies whether an image is fake or real. Note that you do not need a sigmoid after the output layer since it is included in the loss function. Finally, to use your discrimator's neural network you are given a forward pass function that takes in an image tensor to be classified.

In [50]:
# UNQ_C5 (UNIQUE CELL IDENTIFIER, DO NOT EDIT)
# GRADED FUNCTION: Discriminator
class Discriminator(nn.Module):
    '''
    Discriminator Class
    Values:
        im_dim: the dimension of the images, fitted for the dataset used, a scalar
            (MNIST images are 28x28 = 784 so that is your default)
        hidden_dim: the inner dimension, a scalar
    '''
    def __init__(self, im_dim=784, hidden_dim=128):
        super(Discriminator, self).__init__()
        self.disc = nn.Sequential(
            get_discriminator_block(im_dim, hidden_dim * 4),
            get_discriminator_block(hidden_dim * 4, hidden_dim * 2),
            get_discriminator_block(hidden_dim * 2, hidden_dim),
            # Hint: You want to transform the final output into a single value,
            #       so add one more linear map.
            #### START CODE HERE ####
            nn.Linear(hidden_dim, 1)
            #### END CODE HERE ####
        )

    def forward(self, image):
        '''
        Function for completing a forward pass of the discriminator: Given an image tensor, 
        returns a 1-dimension tensor representing fake/real.
        Parameters:
            image: a flattened image tensor with dimension (im_dim)
        '''
        return self.disc(image)
    
    # Needed for grading
    def get_disc(self):
        '''
        Returns:
            the sequential model
        '''
        return self.disc
In [51]:
# Verify the discriminator class
def test_discriminator(z_dim, hidden_dim, num_test=100):
    
    disc = Discriminator(z_dim, hidden_dim).get_disc()

    # Check there are three parts
    assert len(disc) == 4

    # Check the linear layer is correct
    test_input = torch.randn(num_test, z_dim)
    test_output = disc(test_input)
    assert tuple(test_output.shape) == (num_test, 1)
    
    # Make sure there's no sigmoid
    assert test_input.max() > 1
    assert test_input.min() < -1

test_discriminator(5, 10)
test_discriminator(20, 8)
print("Success!")
Success!

Training

Now you can put it all together! First, you will set your parameters:

  • criterion: the loss function
  • n_epochs: the number of times you iterate through the entire dataset when training
  • z_dim: the dimension of the noise vector
  • display_step: how often to display/visualize the images
  • batch_size: the number of images per forward/backward pass
  • lr: the learning rate
  • device: the device type, here using a GPU (which runs CUDA), not CPU

Next, you will load the MNIST dataset as tensors using a dataloader.

In [16]:
# Set your parameters
criterion = nn.BCEWithLogitsLoss()
n_epochs = 200
z_dim = 64
display_step = 500
batch_size = 128
lr = 0.00001
device = 'cuda'
# Load MNIST dataset as tensors
dataloader = DataLoader(
    MNIST('.', download=False, transform=transforms.ToTensor()),
    batch_size=batch_size,
    shuffle=True)

Now, you can initialize your generator, discriminator, and optimizers. Note that each optimizer only takes the parameters of one particular model, since we want each optimizer to optimize only one of the models.

In [17]:
gen = Generator(z_dim).to(device)
gen_opt = torch.optim.Adam(gen.parameters(), lr=lr)
disc = Discriminator().to(device) 
disc_opt = torch.optim.Adam(disc.parameters(), lr=lr)

Before you train your GAN, you will need to create functions to calculate the discriminator's loss and the generator's loss. This is how the discriminator and generator will know how they are doing and improve themselves. Since the generator is needed when calculating the discriminator's loss, you will need to call .detach() on the generator result to ensure that only the discriminator is updated!

Remember that you have already defined a loss function earlier (criterion) and you are encouraged to use torch.ones_like and torch.zeros_like instead of torch.ones or torch.zeros. If you use torch.ones or torch.zeros, you'll need to pass device=device to them.

In [34]:
# UNQ_C6 (UNIQUE CELL IDENTIFIER, DO NOT EDIT)
# GRADED FUNCTION: get_disc_loss
def get_disc_loss(gen, disc, criterion, real, num_images, z_dim, device):
    '''
    Return the loss of the discriminator given inputs.
    Parameters:
        gen: the generator model, which returns an image given z-dimensional noise
        disc: the discriminator model, which returns a single-dimensional prediction of real/fake
        criterion: the loss function, which should be used to compare 
               the discriminator's predictions to the ground truth reality of the images 
               (e.g. fake = 0, real = 1)
        real: a batch of real images
        num_images: the number of images the generator should produce, 
                which is also the length of the real images
        z_dim: the dimension of the noise vector, a scalar
        device: the device type
    Returns:
        disc_loss: a torch scalar loss value for the current batch
    '''
    #     These are the steps you will need to complete:
    #       1) Create noise vectors and generate a batch (num_images) of fake images. 
    #            Make sure to pass the device argument to the noise.
    #       2) Get the discriminator's prediction of the fake image 
    #            and calculate the loss. Don't forget to detach the generator!
    #            (Remember the loss function you set earlier -- criterion. You need a 
    #            'ground truth' tensor in order to calculate the loss. 
    #            For example, a ground truth tensor for a fake image is all zeros.)
    #       3) Get the discriminator's prediction of the real image and calculate the loss.
    #       4) Calculate the discriminator's loss by averaging the real and fake loss
    #            and set it to disc_loss.
    #     Note: Please do not use concatenation in your solution. The tests are being updated to 
    #           support this, but for now, average the two losses as described in step (4).
    #     *Important*: You should NOT write your own loss function here - use criterion(pred, true)!
    #### START CODE HERE ####
    # Step: 1
    noise = get_noise(num_images, z_dim, device=device)
    fakes = gen(noise)
    # Step: 2
    fake_pred = disc(fakes.detach())
    fake_label = torch.zeros_like(fake_pred).to(device)
    fake_loss = criterion(fake_pred, fake_label)
    # Step: 3
    real_pred = disc(real.detach())
    real_label = torch.ones_like(real_pred).to(device)
    real_loss = criterion(real_pred, real_label)
    # Step: 4
    disc_loss = (real_loss + fake_loss)/2
    #### END CODE HERE ####
    return disc_loss
In [35]:
def test_disc_reasonable(num_images=10):
    # Don't use explicit casts to cuda - use the device argument
    import inspect, re
    lines = inspect.getsource(get_disc_loss)
    assert (re.search(r"to\(.cuda.\)", lines)) is None
    assert (re.search(r"\.cuda\(\)", lines)) is None
    
    z_dim = 64
    gen = torch.zeros_like
    disc = lambda x: x.mean(1)[:, None]
    criterion = torch.mul # Multiply
    real = torch.ones(num_images, z_dim)
    disc_loss = get_disc_loss(gen, disc, criterion, real, num_images, z_dim, 'cpu')
    assert torch.all(torch.abs(disc_loss.mean() - 0.5) < 1e-5)
    
    gen = torch.ones_like
    criterion = torch.mul # Multiply
    real = torch.zeros(num_images, z_dim)
    assert torch.all(torch.abs(get_disc_loss(gen, disc, criterion, real, num_images, z_dim, 'cpu')) < 1e-5)
    
    gen = lambda x: torch.ones(num_images, 10)
    disc = lambda x: x.mean(1)[:, None] + 10
    criterion = torch.mul # Multiply
    real = torch.zeros(num_images, 10)
    assert torch.all(torch.abs(get_disc_loss(gen, disc, criterion, real, num_images, z_dim, 'cpu').mean() - 5) < 1e-5)

    gen = torch.ones_like
    disc = nn.Linear(64, 1, bias=False)
    real = torch.ones(num_images, 64) * 0.5
    disc.weight.data = torch.ones_like(disc.weight.data) * 0.5
    disc_opt = torch.optim.Adam(disc.parameters(), lr=lr)
    criterion = lambda x, y: torch.sum(x) + torch.sum(y)
    disc_loss = get_disc_loss(gen, disc, criterion, real, num_images, z_dim, 'cpu').mean()
    disc_loss.backward()
    assert torch.isclose(torch.abs(disc.weight.grad.mean() - 11.25), torch.tensor(3.75))
    
def test_disc_loss(max_tests = 10):
    z_dim = 64
    gen = Generator(z_dim).to(device)
    gen_opt = torch.optim.Adam(gen.parameters(), lr=lr)
    disc = Discriminator().to(device) 
    disc_opt = torch.optim.Adam(disc.parameters(), lr=lr)
    num_steps = 0
    for real, _ in dataloader:
        cur_batch_size = len(real)
        real = real.view(cur_batch_size, -1).to(device)

        ### Update discriminator ###
        # Zero out the gradient before backpropagation
        disc_opt.zero_grad()

        # Calculate discriminator loss
        disc_loss = get_disc_loss(gen, disc, criterion, real, cur_batch_size, z_dim, device)
        assert (disc_loss - 0.68).abs() < 0.05

        # Update gradients
        disc_loss.backward(retain_graph=True)

        # Check that they detached correctly
        assert gen.gen[0][0].weight.grad is None

        # Update optimizer
        old_weight = disc.disc[0][0].weight.data.clone()
        disc_opt.step()
        new_weight = disc.disc[0][0].weight.data
        
        # Check that some discriminator weights changed
        assert not torch.all(torch.eq(old_weight, new_weight))
        num_steps += 1
        if num_steps >= max_tests:
            break

test_disc_reasonable()
test_disc_loss()
print("Success!")
Success!
In [44]:
# UNQ_C7 (UNIQUE CELL IDENTIFIER, DO NOT EDIT)
# GRADED FUNCTION: get_gen_loss
def get_gen_loss(gen, disc, criterion, num_images, z_dim, device):
    '''
    Return the loss of the generator given inputs.
    Parameters:
        gen: the generator model, which returns an image given z-dimensional noise
        disc: the discriminator model, which returns a single-dimensional prediction of real/fake
        criterion: the loss function, which should be used to compare 
               the discriminator's predictions to the ground truth reality of the images 
               (e.g. fake = 0, real = 1)
        num_images: the number of images the generator should produce, 
                which is also the length of the real images
        z_dim: the dimension of the noise vector, a scalar
        device: the device type
    Returns:
        gen_loss: a torch scalar loss value for the current batch
    '''
    #     These are the steps you will need to complete:
    #       1) Create noise vectors and generate a batch of fake images. 
    #           Remember to pass the device argument to the get_noise function.
    #       2) Get the discriminator's prediction of the fake image.
    #       3) Calculate the generator's loss. Remember the generator wants
    #          the discriminator to think that its fake images are real
    #     *Important*: You should NOT write your own loss function here - use criterion(pred, true)!

    #### START CODE HERE ####
    noise = get_noise(num_images, z_dim, device=device)
    fake = gen(noise)
    pred_fake = disc(fake)
    real = torch.ones_like(pred_fake).to(device)
    gen_loss = criterion(pred_fake, real)
    #### END CODE HERE ####
    return gen_loss
In [48]:
def test_gen_reasonable(num_images=10):
    # Don't use explicit casts to cuda - use the device argument
    import inspect, re
    lines = inspect.getsource(get_gen_loss)
    assert (re.search(r"to\(.cuda.\)", lines)) is None
    assert (re.search(r"\.cuda\(\)", lines)) is None
    
    z_dim = 64
    gen = torch.zeros_like
    disc = nn.Identity()
    criterion = torch.mul # Multiply
    gen_loss_tensor = get_gen_loss(gen, disc, criterion, num_images, z_dim, 'cpu')
    assert torch.all(torch.abs(gen_loss_tensor) < 1e-5)
    #Verify shape. Related to gen_noise parametrization
    assert tuple(gen_loss_tensor.shape) == (num_images, z_dim)

    gen = torch.ones_like
    disc = nn.Identity()
    criterion = torch.mul # Multiply
    real = torch.zeros(num_images, 1)
    gen_loss_tensor = get_gen_loss(gen, disc, criterion, num_images, z_dim, 'cpu')
    assert torch.all(torch.abs(gen_loss_tensor - 1) < 1e-5)
    #Verify shape. Related to gen_noise parametrization
    assert tuple(gen_loss_tensor.shape) == (num_images, z_dim)
    

def test_gen_loss(num_images):
    z_dim = 64
    gen = Generator(z_dim).to(device)
    gen_opt = torch.optim.Adam(gen.parameters(), lr=lr)
    disc = Discriminator().to(device) 
    disc_opt = torch.optim.Adam(disc.parameters(), lr=lr)
    
    gen_loss = get_gen_loss(gen, disc, criterion, num_images, z_dim, device)
    
    # Check that the loss is reasonable
    assert (gen_loss - 0.7).abs() < 0.1
    gen_loss.backward()
    old_weight = gen.gen[0][0].weight.clone()
    gen_opt.step()
    new_weight = gen.gen[0][0].weight
    assert not torch.all(torch.eq(old_weight, new_weight))


test_gen_reasonable(10)
test_gen_loss(18)
print("Success!")
Success!

Finally, you can put everything together! For each epoch, you will process the entire dataset in batches. For every batch, you will need to update the discriminator and generator using their loss. Batches are sets of images that will be predicted on before the loss functions are calculated (instead of calculating the loss function after each image). Note that you may see a loss to be greater than 1, this is okay since binary cross entropy loss can be any positive number for a sufficiently confident wrong guess.

It’s also often the case that the discriminator will outperform the generator, especially at the start, because its job is easier. It's important that neither one gets too good (that is, near-perfect accuracy), which would cause the entire model to stop learning. Balancing the two models is actually remarkably hard to do in a standard GAN and something you will see more of in later lectures and assignments.

After you've submitted a working version with the original architecture, feel free to play around with the architecture if you want to see how different architectural choices can lead to better or worse GANs. For example, consider changing the size of the hidden dimension, or making the networks shallower or deeper by changing the number of layers.

But remember, don’t expect anything spectacular: this is only the first lesson. The results will get better with later lessons as you learn methods to help keep your generator and discriminator at similar levels.

You should roughly expect to see this progression. On a GPU, this should take about 15 seconds per 500 steps, on average, while on CPU it will take roughly 1.5 minutes: MNIST Digits

In [49]:
# UNQ_C8 (UNIQUE CELL IDENTIFIER, DO NOT EDIT)
# GRADED FUNCTION: 

cur_step = 0
mean_generator_loss = 0
mean_discriminator_loss = 0
test_generator = True # Whether the generator should be tested
gen_loss = False
error = False
for epoch in range(n_epochs):
  
    # Dataloader returns the batches
    for real, _ in tqdm(dataloader):
        cur_batch_size = len(real)

        # Flatten the batch of real images from the dataset
        real = real.view(cur_batch_size, -1).to(device)

        ### Update discriminator ###
        # Zero out the gradients before backpropagation
        disc_opt.zero_grad()

        # Calculate discriminator loss
        disc_loss = get_disc_loss(gen, disc, criterion, real, cur_batch_size, z_dim, device)

        # Update gradients
        disc_loss.backward(retain_graph=True)

        # Update optimizer
        disc_opt.step()

        # For testing purposes, to keep track of the generator weights
        if test_generator:
            old_generator_weights = gen.gen[0][0].weight.detach().clone()

        ### Update generator ###
        #     Hint: This code will look a lot like the discriminator updates!
        #     These are the steps you will need to complete:
        #       1) Zero out the gradients.
        #       2) Calculate the generator loss, assigning it to gen_loss.
        #       3) Backprop through the generator: update the gradients and optimizer.
        #### START CODE HERE ####
        gen_opt.zero_grad()
        gen_loss = get_gen_loss(gen, disc, criterion, cur_batch_size, z_dim, device)
        gen_loss.backward()
        gen_opt.step()
        #### END CODE HERE ####

        # For testing purposes, to check that your code changes the generator weights
        if test_generator:
            try:
                assert lr > 0.0000002 or (gen.gen[0][0].weight.grad.abs().max() < 0.0005 and epoch == 0)
                assert torch.any(gen.gen[0][0].weight.detach().clone() != old_generator_weights)
            except:
                error = True
                print("Runtime tests have failed")

        # Keep track of the average discriminator loss
        mean_discriminator_loss += disc_loss.item() / display_step

        # Keep track of the average generator loss
        mean_generator_loss += gen_loss.item() / display_step

        ### Visualization code ###
        if cur_step % display_step == 0 and cur_step > 0:
            print(f"Epoch {epoch}, step {cur_step}: Generator loss: {mean_generator_loss}, discriminator loss: {mean_discriminator_loss}")
            fake_noise = get_noise(cur_batch_size, z_dim, device=device)
            fake = gen(fake_noise)
            show_tensor_images(fake)
            show_tensor_images(real)
            mean_generator_loss = 0
            mean_discriminator_loss = 0
        cur_step += 1

Epoch 1, step 500: Generator loss: 0.8193847110271456, discriminator loss: 0.5372567342519763

Epoch 2, step 1000: Generator loss: 0.8318188158273695, discriminator loss: 0.4163570932149894

Epoch 3, step 1500: Generator loss: 1.003414867520332, discriminator loss: 0.2933517562150954

Epoch 4, step 2000: Generator loss: 0.9340330135822305, discriminator loss: 0.32845220696926114

Epoch 5, step 2500: Generator loss: 0.7987405349016182, discriminator loss: 0.43025246953964225

Epoch 6, step 3000: Generator loss: 0.8034094117879867, discriminator loss: 0.3967787454724312

Epoch 7, step 3500: Generator loss: 0.8534374697208403, discriminator loss: 0.3415162836313245

Epoch 8, step 4000: Generator loss: 0.9392707903385161, discriminator loss: 0.322004741668701

Epoch 9, step 4500: Generator loss: 1.02923064482212, discriminator loss: 0.2863801377415659

Epoch 10, step 5000: Generator loss: 1.1668343307971962, discriminator loss: 0.2579889068305492

Epoch 11, step 5500: Generator loss: 1.2417020504474645, discriminator loss: 0.25308992916345596

Epoch 12, step 6000: Generator loss: 1.4354540467262273, discriminator loss: 0.2133263907134532

Epoch 13, step 6500: Generator loss: 1.580941502094269, discriminator loss: 0.19680028215050707

Epoch 14, step 7000: Generator loss: 1.678850536346435, discriminator loss: 0.18508075609803196

Epoch 15, step 7500: Generator loss: 1.7482424216270462, discriminator loss: 0.1767189025282861


Epoch 17, step 8000: Generator loss: 1.786916611909864, discriminator loss: 0.17590522220730773

Epoch 18, step 8500: Generator loss: 1.9396014840602875, discriminator loss: 0.152825960069895

Epoch 19, step 9000: Generator loss: 2.020528087139128, discriminator loss: 0.1484192884117364

Epoch 20, step 9500: Generator loss: 2.050234608650207, discriminator loss: 0.15132548323273654

Epoch 21, step 10000: Generator loss: 2.0255846743583676, discriminator loss: 0.15748522208631047

Epoch 22, step 10500: Generator loss: 2.1424095911979673, discriminator loss: 0.14613707506656656

Epoch 23, step 11000: Generator loss: 2.1067597198486334, discriminator loss: 0.1581288568228485

Epoch 24, step 11500: Generator loss: 2.1927694730758662, discriminator loss: 0.14784299585223198

Epoch 25, step 12000: Generator loss: 2.168673020362855, discriminator loss: 0.15681547547876817

Epoch 26, step 12500: Generator loss: 2.2212576215267177, discriminator loss: 0.1644851198643446

Epoch 27, step 13000: Generator loss: 2.161678834199905, discriminator loss: 0.16920738098025317

Epoch 28, step 13500: Generator loss: 2.2226032602787016, discriminator loss: 0.17424627862870695

Epoch 29, step 14000: Generator loss: 2.3338785266876205, discriminator loss: 0.16212730178236975

Epoch 30, step 14500: Generator loss: 2.2520372743606596, discriminator loss: 0.17118040758371372

Epoch 31, step 15000: Generator loss: 2.3422766160964965, discriminator loss: 0.16092337660491451


Epoch 33, step 15500: Generator loss: 2.27908830165863, discriminator loss: 0.18240259632468223

Epoch 34, step 16000: Generator loss: 2.2172220063209522, discriminator loss: 0.21094774091243734

Epoch 35, step 16500: Generator loss: 2.1778497164249395, discriminator loss: 0.20096952155232425

Epoch 36, step 17000: Generator loss: 2.0500099513530725, discriminator loss: 0.2346549976766111

Epoch 37, step 17500: Generator loss: 2.1148694050312034, discriminator loss: 0.22512322619557373

Epoch 38, step 18000: Generator loss: 2.170444409608841, discriminator loss: 0.22767303287982954

Epoch 39, step 18500: Generator loss: 2.075238007068635, discriminator loss: 0.2612470426261424

Epoch 40, step 19000: Generator loss: 1.9998666141033163, discriminator loss: 0.2502260348796843

Epoch 41, step 19500: Generator loss: 2.109411653518676, discriminator loss: 0.23490007594227785

Epoch 42, step 20000: Generator loss: 2.1262702658176424, discriminator loss: 0.22649669787287727

Epoch 43, step 20500: Generator loss: 2.1880725500583607, discriminator loss: 0.21862318864464766

Epoch 44, step 21000: Generator loss: 1.986985017299653, discriminator loss: 0.26484722959995255

Epoch 45, step 21500: Generator loss: 2.0164156274795526, discriminator loss: 0.2705982517302037

Epoch 46, step 22000: Generator loss: 2.0073636915683735, discriminator loss: 0.2705978079140187

Epoch 47, step 22500: Generator loss: 1.9925006721019745, discriminator loss: 0.26667911937832833


Epoch 49, step 23000: Generator loss: 1.9596858909130097, discriminator loss: 0.3267646520733832

Epoch 50, step 23500: Generator loss: 1.8785667555332184, discriminator loss: 0.3385714959800243

Epoch 51, step 24000: Generator loss: 1.8273921816349041, discriminator loss: 0.31550951093435275

Epoch 52, step 24500: Generator loss: 1.7983555703163137, discriminator loss: 0.3162818458378321

Epoch 53, step 25000: Generator loss: 1.8047687985897067, discriminator loss: 0.31833660218119614

Epoch 54, step 25500: Generator loss: 1.7581794025897983, discriminator loss: 0.345098977178335

Epoch 55, step 26000: Generator loss: 1.7378027377128598, discriminator loss: 0.3654034370779988

Epoch 56, step 26500: Generator loss: 1.7692372012138395, discriminator loss: 0.3136828369498252

Epoch 57, step 27000: Generator loss: 1.680227639675142, discriminator loss: 0.37055277121067076

Epoch 58, step 27500: Generator loss: 1.6139171113967892, discriminator loss: 0.3657873769104481

Epoch 59, step 28000: Generator loss: 1.64009009861946, discriminator loss: 0.35364254122972477

Epoch 60, step 28500: Generator loss: 1.6316380734443663, discriminator loss: 0.3330814959406853

Epoch 61, step 29000: Generator loss: 1.6831120042800893, discriminator loss: 0.3402902316451074

Epoch 62, step 29500: Generator loss: 1.6481372141838087, discriminator loss: 0.3538159301877027

Epoch 63, step 30000: Generator loss: 1.6630373010635362, discriminator loss: 0.3456628045439722


Epoch 65, step 30500: Generator loss: 1.647282421827319, discriminator loss: 0.35242974179983166

Epoch 66, step 31000: Generator loss: 1.5975265638828269, discriminator loss: 0.38266713660955415

Epoch 67, step 31500: Generator loss: 1.5284956953525564, discriminator loss: 0.37125729721784645

Epoch 68, step 32000: Generator loss: 1.5701030673980712, discriminator loss: 0.3696422346830364

Epoch 69, step 32500: Generator loss: 1.5736829946041102, discriminator loss: 0.3523425728678704

Epoch 70, step 33000: Generator loss: 1.6197900626659398, discriminator loss: 0.3604217579364776

Epoch 71, step 33500: Generator loss: 1.5345091204643238, discriminator loss: 0.3861185694932939

Epoch 72, step 34000: Generator loss: 1.619318523406982, discriminator loss: 0.3639631451964381

Epoch 73, step 34500: Generator loss: 1.4900771055221558, discriminator loss: 0.4299428866505624

Epoch 74, step 35000: Generator loss: 1.5047749366760241, discriminator loss: 0.39636513954400965

Epoch 75, step 35500: Generator loss: 1.5140928151607496, discriminator loss: 0.37766037398576763

Epoch 76, step 36000: Generator loss: 1.4516244306564334, discriminator loss: 0.40198966938257213

Epoch 77, step 36500: Generator loss: 1.4475006062984481, discriminator loss: 0.39293549913167913

Epoch 78, step 37000: Generator loss: 1.4943120851516734, discriminator loss: 0.39253992384672176

Epoch 79, step 37500: Generator loss: 1.4705930817127215, discriminator loss: 0.41101326727867105


Epoch 81, step 38000: Generator loss: 1.4347250275611885, discriminator loss: 0.3931389868855473

Epoch 82, step 38500: Generator loss: 1.503221621990204, discriminator loss: 0.3788821706771853

Epoch 83, step 39000: Generator loss: 1.5054673743247986, discriminator loss: 0.39024650502204916

Epoch 84, step 39500: Generator loss: 1.4884461584091198, discriminator loss: 0.3977991891503333

Epoch 85, step 40000: Generator loss: 1.3829933159351349, discriminator loss: 0.4218574724793432

Epoch 86, step 40500: Generator loss: 1.4559497227668767, discriminator loss: 0.3755613085031507

Epoch 87, step 41000: Generator loss: 1.4641523549556739, discriminator loss: 0.40592079728841796

Epoch 88, step 41500: Generator loss: 1.4526041896343225, discriminator loss: 0.4112896811962123

Epoch 89, step 42000: Generator loss: 1.4125132477283462, discriminator loss: 0.41370134013891247

Epoch 90, step 42500: Generator loss: 1.348997416257858, discriminator loss: 0.4418136384487155

Epoch 91, step 43000: Generator loss: 1.3134477150440216, discriminator loss: 0.4402451325058938

Epoch 92, step 43500: Generator loss: 1.35259468483925, discriminator loss: 0.42402845394611355

Epoch 93, step 44000: Generator loss: 1.2923265190124524, discriminator loss: 0.4678076123595239

Epoch 94, step 44500: Generator loss: 1.2491910204887395, discriminator loss: 0.4553223144412043

Epoch 95, step 45000: Generator loss: 1.3540481207370743, discriminator loss: 0.43029138010740275


Epoch 97, step 45500: Generator loss: 1.2894136638641343, discriminator loss: 0.4620713053345674

Epoch 98, step 46000: Generator loss: 1.2866943132877353, discriminator loss: 0.46755747890472443

Epoch 99, step 46500: Generator loss: 1.1587081065177913, discriminator loss: 0.5136428054571148

Epoch 100, step 47000: Generator loss: 1.2470485689640036, discriminator loss: 0.4664360209107402

Epoch 101, step 47500: Generator loss: 1.1765750641822816, discriminator loss: 0.5004491761922835

Epoch 102, step 48000: Generator loss: 1.1993205711841586, discriminator loss: 0.4487896645069117

Epoch 103, step 48500: Generator loss: 1.2915919501781465, discriminator loss: 0.42840239864587776

Epoch 104, step 49000: Generator loss: 1.2780636785030357, discriminator loss: 0.4569194896221163

Epoch 105, step 49500: Generator loss: 1.2633602712154388, discriminator loss: 0.448623391270637

Epoch 106, step 50000: Generator loss: 1.268883503913879, discriminator loss: 0.43301594364643115

Epoch 107, step 50500: Generator loss: 1.2683949432373065, discriminator loss: 0.46226587933301966

Epoch 108, step 51000: Generator loss: 1.223764773845672, discriminator loss: 0.45960311830043776

Epoch 109, step 51500: Generator loss: 1.2629232075214403, discriminator loss: 0.45474962377548184

Epoch 110, step 52000: Generator loss: 1.2231491324901576, discriminator loss: 0.4722252357006076

Epoch 111, step 52500: Generator loss: 1.230366331100463, discriminator loss: 0.47076436012983314


Epoch 113, step 53000: Generator loss: 1.213658956766128, discriminator loss: 0.4633542211651807

Epoch 114, step 53500: Generator loss: 1.252267264604568, discriminator loss: 0.4521671238541606

Epoch 115, step 54000: Generator loss: 1.2197640419006364, discriminator loss: 0.4838465462923053

Epoch 116, step 54500: Generator loss: 1.2304828817844384, discriminator loss: 0.42688311088085173

Epoch 117, step 55000: Generator loss: 1.2913756003379826, discriminator loss: 0.4385283098220823

Epoch 118, step 55500: Generator loss: 1.2158202323913576, discriminator loss: 0.4738843307495118

Epoch 119, step 56000: Generator loss: 1.2240039443969721, discriminator loss: 0.46251194906234727

Epoch 120, step 56500: Generator loss: 1.228969564437867, discriminator loss: 0.4551346024274821

Epoch 121, step 57000: Generator loss: 1.2460783894062035, discriminator loss: 0.43994242507219344

Epoch 122, step 57500: Generator loss: 1.251152607917785, discriminator loss: 0.4459560446739197

Epoch 123, step 58000: Generator loss: 1.2119564881324774, discriminator loss: 0.4781605813503271

Epoch 124, step 58500: Generator loss: 1.2459531321525579, discriminator loss: 0.42794599664211286

Epoch 125, step 59000: Generator loss: 1.2832385098934158, discriminator loss: 0.4262566888928411

Epoch 126, step 59500: Generator loss: 1.27613032746315, discriminator loss: 0.4627307443022729

Epoch 127, step 60000: Generator loss: 1.1895736331939688, discriminator loss: 0.4855297668576241

Epoch 128, step 60500: Generator loss: 1.2080075721740726, discriminator loss: 0.48546324080228814


Epoch 130, step 61000: Generator loss: 1.188796909570694, discriminator loss: 0.47381463527679474

Epoch 131, step 61500: Generator loss: 1.1616989920139302, discriminator loss: 0.5022964898347853

Epoch 132, step 62000: Generator loss: 1.1694845725297924, discriminator loss: 0.4776892937421799

Epoch 133, step 62500: Generator loss: 1.178072883605957, discriminator loss: 0.48518799614906327

Epoch 134, step 63000: Generator loss: 1.1652033145427712, discriminator loss: 0.4879156239628792

Epoch 135, step 63500: Generator loss: 1.1446139287948613, discriminator loss: 0.4806474294066426

Epoch 136, step 64000: Generator loss: 1.1773245768547056, discriminator loss: 0.4735451163053518

Epoch 137, step 64500: Generator loss: 1.154958949804307, discriminator loss: 0.5192419397234916

Epoch 138, step 65000: Generator loss: 1.0551954382658, discriminator loss: 0.5197464572787279

Epoch 139, step 65500: Generator loss: 1.0798781350851054, discriminator loss: 0.5142835429906847

Epoch 140, step 66000: Generator loss: 1.1053093631267543, discriminator loss: 0.49008008068799963

Epoch 141, step 66500: Generator loss: 1.1020923160314573, discriminator loss: 0.5062838797569273

Epoch 142, step 67000: Generator loss: 1.1345327177047726, discriminator loss: 0.49119795262813565

Epoch 143, step 67500: Generator loss: 1.147107587814331, discriminator loss: 0.4829196670055389

Epoch 144, step 68000: Generator loss: 1.1170268564224237, discriminator loss: 0.5142651888132095


Epoch 146, step 68500: Generator loss: 1.108485059142112, discriminator loss: 0.5069880421757698

Epoch 147, step 69000: Generator loss: 1.07923049545288, discriminator loss: 0.5323081346750258

Epoch 148, step 69500: Generator loss: 1.12148086476326, discriminator loss: 0.4589444226026539

Epoch 149, step 70000: Generator loss: 1.159498156547547, discriminator loss: 0.48665138310193956

Epoch 150, step 70500: Generator loss: 1.129648901939391, discriminator loss: 0.5117847388982772

Epoch 151, step 71000: Generator loss: 1.125317570567132, discriminator loss: 0.49824904686212507

Epoch 152, step 71500: Generator loss: 1.1098297988176349, discriminator loss: 0.5373074743747713

Epoch 153, step 72000: Generator loss: 1.0685154132843022, discriminator loss: 0.5098384104371071

Epoch 154, step 72500: Generator loss: 1.090510900259019, discriminator loss: 0.5031715309023859

Epoch 155, step 73000: Generator loss: 1.116480977058411, discriminator loss: 0.5177729146480562

Epoch 156, step 73500: Generator loss: 1.0597662991285324, discriminator loss: 0.5537859327197074

Epoch 157, step 74000: Generator loss: 1.0231775115728383, discriminator loss: 0.5247816616296773

Epoch 158, step 74500: Generator loss: 1.0163263324499137, discriminator loss: 0.5377656494975095

Epoch 159, step 75000: Generator loss: 1.0484971976280208, discriminator loss: 0.5112034648656849

Epoch 160, step 75500: Generator loss: 1.0553442169427865, discriminator loss: 0.5668741322755815


Epoch 162, step 76000: Generator loss: 0.9973432271480561, discriminator loss: 0.5063040743470194

Epoch 163, step 76500: Generator loss: 1.0537570859193799, discriminator loss: 0.5243747227191923

Epoch 164, step 77000: Generator loss: 1.0244937347173682, discriminator loss: 0.5539891861677166

Epoch 165, step 77500: Generator loss: 1.0053464781045913, discriminator loss: 0.5462551887631416

Epoch 166, step 78000: Generator loss: 0.9938432390689839, discriminator loss: 0.5416112089753146

Epoch 167, step 78500: Generator loss: 1.0055581958293913, discriminator loss: 0.5353851017951962

Epoch 168, step 79000: Generator loss: 1.027643832206726, discriminator loss: 0.5419547052979472

Epoch 169, step 79500: Generator loss: 1.0112878601551056, discriminator loss: 0.5713457152843476

Epoch 170, step 80000: Generator loss: 0.9803205931186665, discriminator loss: 0.5404418485760686

Epoch 171, step 80500: Generator loss: 1.0100195018053066, discriminator loss: 0.5158759968876834

Epoch 172, step 81000: Generator loss: 1.0083193180561065, discriminator loss: 0.5311050153970718

Epoch 173, step 81500: Generator loss: 1.001674000024795, discriminator loss: 0.5396337378621101

Epoch 174, step 82000: Generator loss: 0.9915786647796626, discriminator loss: 0.5242765529751776

Epoch 175, step 82500: Generator loss: 1.030150413155555, discriminator loss: 0.5387964938282972

Epoch 176, step 83000: Generator loss: 0.9939098085165022, discriminator loss: 0.5210974246859552


Epoch 178, step 83500: Generator loss: 1.0220096237659464, discriminator loss: 0.5467432314157479

Epoch 179, step 84000: Generator loss: 1.0007530636787416, discriminator loss: 0.5513677371740338

Epoch 180, step 84500: Generator loss: 0.9687749372720715, discriminator loss: 0.5562805368304253

Epoch 181, step 85000: Generator loss: 0.9727687358856197, discriminator loss: 0.5281807909011842

Epoch 182, step 85500: Generator loss: 0.9754302717447282, discriminator loss: 0.523767125964165

Epoch 183, step 86000: Generator loss: 1.0268261960744853, discriminator loss: 0.518896758556366

Epoch 184, step 86500: Generator loss: 1.0164184048175815, discriminator loss: 0.5301449312567713

Epoch 185, step 87000: Generator loss: 1.007412316918373, discriminator loss: 0.5592196858525273

Epoch 186, step 87500: Generator loss: 1.0041028077602376, discriminator loss: 0.5361604086756712

Epoch 187, step 88000: Generator loss: 0.9967906919717784, discriminator loss: 0.5463262100219723

Epoch 188, step 88500: Generator loss: 0.9824601004123689, discriminator loss: 0.523596300125122

Epoch 189, step 89000: Generator loss: 1.0187966752052304, discriminator loss: 0.5143297539949419

Epoch 190, step 89500: Generator loss: 1.0103804616928103, discriminator loss: 0.5387238596081727

Epoch 191, step 90000: Generator loss: 1.0314170062541959, discriminator loss: 0.5285161572098732

Epoch 192, step 90500: Generator loss: 1.0153346090316782, discriminator loss: 0.5319748148322108


Epoch 194, step 91000: Generator loss: 1.0103037724494934, discriminator loss: 0.5319719086289405

Epoch 195, step 91500: Generator loss: 0.9722920233011253, discriminator loss: 0.556717423737049

Epoch 196, step 92000: Generator loss: 0.969243315815926, discriminator loss: 0.5493189494013786

Epoch 197, step 92500: Generator loss: 0.9879710508584975, discriminator loss: 0.5401706336140628

Epoch 198, step 93000: Generator loss: 0.9637263137102122, discriminator loss: 0.5289613605141641

Epoch 199, step 93500: Generator loss: 1.035534656524658, discriminator loss: 0.5033422428369523